/*
 * $Header:
 * /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons
 * //httpclient/src/java/org/apache/commons/httpclient/HeaderGroup.java,v 1.8
 * 2004/05/13 04:03:25 mbecke Exp $ $Revision: 480424 $ $Date: 2006-11-29
 * 06:56:49 +0100 (Wed, 29 Nov 2006) $
 *
 * ====================================================================
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to You under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many individuals on
 * behalf of the Apache Software Foundation. For more information on the Apache
 * Software Foundation, please see <http://www.apache.org/>.
 */

package com.microsoft.tfs.core.httpclient;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

/**
 * A class for combining a set of headers. This class allows for multiple
 * headers with the same name and keeps track of the order in which headers were
 * added.
 *
 * @author Michael Becke
 *
 * @since 2.0beta1
 */
public class HeaderGroup {

    /**
     * The list of headers for this group, in the order in which they were added
     */
    private final List headers;

    /**
     * Constructor for HeaderGroup.
     */
    public HeaderGroup() {
        headers = new ArrayList();
    }

    /**
     * Removes any contained headers.
     */
    public void clear() {
        headers.clear();
    }

    /**
     * Adds the given header to the group. The order in which this header was
     * added is preserved.
     *
     * @param header
     *        the header to add
     */
    public void addHeader(final Header header) {
        headers.add(header);
    }

    /**
     * Removes the given header.
     *
     * @param header
     *        the header to remove
     */
    public void removeHeader(final Header header) {
        headers.remove(header);
    }

    /**
     * Sets all of the headers contained within this group overriding any
     * existing headers. The headers are added in the order in which they appear
     * in the array.
     *
     * @param headers
     *        the headers to set
     */
    public void setHeaders(final Header[] headers) {
        clear();

        for (int i = 0; i < headers.length; i++) {
            addHeader(headers[i]);
        }
    }

    /**
     * Gets a header representing all of the header values with the given name.
     * If more that one header with the given name exists the values will be
     * combined with a "," as per RFC 2616.
     *
     * <p>
     * Header name comparison is case insensitive.
     *
     * @param name
     *        the name of the header(s) to get
     * @return a header with a condensed value or <code>null</code> if no
     *         headers by the given name are present
     */
    public Header getCondensedHeader(final String name) {
        final Header[] headers = getHeaders(name);

        if (headers.length == 0) {
            return null;
        } else if (headers.length == 1) {
            return new Header(headers[0].getName(), headers[0].getValue());
        } else {
            final StringBuffer valueBuffer = new StringBuffer(headers[0].getValue());

            for (int i = 1; i < headers.length; i++) {
                valueBuffer.append(", ");
                valueBuffer.append(headers[i].getValue());
            }

            return new Header(name.toLowerCase(), valueBuffer.toString());
        }
    }

    /**
     * Gets all of the headers with the given name. The returned array maintains
     * the relative order in which the headers were added.
     *
     * <p>
     * Header name comparison is case insensitive.
     *
     * @param name
     *        the name of the header(s) to get
     *
     * @return an array of length >= 0
     */
    public Header[] getHeaders(final String name) {
        final ArrayList headersFound = new ArrayList();

        for (final Iterator headerIter = headers.iterator(); headerIter.hasNext();) {
            final Header header = (Header) headerIter.next();
            if (header.getName().equalsIgnoreCase(name)) {
                headersFound.add(header);
            }
        }

        return (Header[]) headersFound.toArray(new Header[headersFound.size()]);
    }

    /**
     * Gets the first header with the given name.
     *
     * <p>
     * Header name comparison is case insensitive.
     *
     * @param name
     *        the name of the header to get
     * @return the first header or <code>null</code>
     */
    public Header getFirstHeader(final String name) {
        for (final Iterator headerIter = headers.iterator(); headerIter.hasNext();) {
            final Header header = (Header) headerIter.next();
            if (header.getName().equalsIgnoreCase(name)) {
                return header;
            }
        }

        return null;
    }

    /**
     * Gets the last header with the given name.
     *
     * <p>
     * Header name comparison is case insensitive.
     *
     * @param name
     *        the name of the header to get
     * @return the last header or <code>null</code>
     */
    public Header getLastHeader(final String name) {
        // start at the end of the list and work backwards
        for (int i = headers.size() - 1; i >= 0; i--) {
            final Header header = (Header) headers.get(i);
            if (header.getName().equalsIgnoreCase(name)) {
                return header;
            }
        }

        return null;
    }

    /**
     * Gets all of the headers contained within this group.
     *
     * @return an array of length >= 0
     */
    public Header[] getAllHeaders() {
        return (Header[]) headers.toArray(new Header[headers.size()]);
    }

    /**
     * Tests if headers with the given name are contained within this group.
     *
     * <p>
     * Header name comparison is case insensitive.
     *
     * @param name
     *        the header name to test for
     * @return <code>true</code> if at least one header with the name is
     *         contained, <code>false</code> otherwise
     */
    public boolean containsHeader(final String name) {
        for (final Iterator headerIter = headers.iterator(); headerIter.hasNext();) {
            final Header header = (Header) headerIter.next();
            if (header.getName().equalsIgnoreCase(name)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Returns an iterator over this group of headers.
     *
     * @return iterator over this group of headers.
     *
     * @since 3.0
     */
    public Iterator getIterator() {
        return headers.iterator();
    }
}
